home *** CD-ROM | disk | FTP | other *** search
/ Delphi Programmer's Power Pack / Delphi Volume 1.iso / s_to_z / uback / read.me < prev    next >
Text File  |  1996-09-15  |  19KB  |  384 lines

  1. Introduction
  2. ============
  3.  
  4. UBACKUP
  5.  
  6. Version History - for new features see WHATSNEW.TXT
  7.  
  8. 1.00 released 1. December 1995
  9. 1.01 release 27. December 1995
  10. 1.02 released 14. January 1996
  11.  
  12. A native Delphi component to take the pain out of backing up your applications
  13. data.
  14.  
  15. (C)  UDEEDV GmbH 1995,1996
  16.  
  17. Just drop this component on your form, set some of its properties and with one
  18. line of code you have a complete backup to any drive you like.
  19.  
  20. Features:
  21.  
  22. * Multi volume backup on disks and removable media 
  23. * Data is safely backed up using CRC-32 block checksums
  24. * Included fast data compression with modified LZSS algorithm
  25. * File selection with wildcards, optional including subdirs
  26. * File dates and attributes restored
  27. * Optional deletion of existing files on target drive
  28. * Calculates percentage of work done yet
  29. * Multi language support (German, English supported yet)
  30. * Many events accessible through your application
  31. * name of backup archives variable
  32. * non existing directories will be created
  33. * GetInfo retrieves all files in a backup set
  34. * calculated remaining time to complete the task
  35. * selective restore to restore only files selected
  36.  
  37. Shareware version is fully functional but runs only under Borland IDE. Registered users will get a full version, source code and one year free updates. Registration is US$ 50 or DM 69.
  38. Register via SWREG #8741 Uploaded by the author.
  39. To contact: CIS 100112,2777. Arnold Ude
  40.  
  41. How to use UBACKUP
  42. ==================
  43.  
  44. Installation
  45. ============
  46.  
  47. First copy at least the files
  48. UBACKUP.DCU, UBACKUP.DCR, UDEBIB.DCU, LZSSLIB.DCU to a single directory
  49. of your choice. To install UBACKUP to your development system,
  50. call "Options..Install new component" from the Borland IDE.
  51. Add the file UBACKUP.DCU and rebuild your component library.
  52. The new component should be in your button bar under the section UWARE.
  53. Clicking the right mouse button you can configurate your
  54. button bar to move the UBACKUP-Icon in any section you like.
  55.  
  56. Quickstart of using UBACKUP
  57. ===========================
  58.  
  59. UBACKUP provides an easy way to backup the files of your application to any
  60. drive or disk. To use UBACKUP follow the steps:
  61.  
  62. 1.)  Drop the UBACKUP component on your form
  63. 2.)  Set the following properties:
  64.       Use the FilesToBackup property to specify what to backup:
  65.          Use one line per specification, each line can contain 
  66.          a fully qualified filename with or without wildcards (*,?). If you
  67.          want UBACKUP to backup all matching files in Subdirs too just add
  68.          to the line a /S.
  69.       Set Compression to true, if you want the being compressed during backup
  70.       Set FileList to the path and name of your file name list file
  71.       OR
  72.       Set FilesToBackup to an expression describing the files you want
  73.       to backup e.g. c:\test\*.pas
  74.       Set BackupOn to the Drive and optional path of the destination of
  75.           your backup
  76.       Set Overwrite to true, if you want existing files being overwritten
  77.           without confirmation
  78.       Set Description to any descriptional text of the backup set or
  79.           leave it blank
  80.       Set Language to English or German as you prefer for eventually
  81.           shown message boxes
  82. 4.)  Insert anywhere in your code (perhaps as reaction of a button being
  83.      clicked) the line:
  84.           Ubackup1.Backup;
  85. 5.)  Compile and run
  86.  
  87. To have your files being restored to the original destination just write a line 
  88. Ubackup1.Restore;
  89.  
  90. Short Technical Documentation of UBACKUP
  91. ========================================
  92.  
  93. Properties
  94. ==========
  95. Compression : Boolean;    This property allows the user to decide, if UBACKUP
  96.                         should compress the data during the backup and
  97.                         decompress it during restore. If this property is set
  98.                         to true UBACKUP tries to compress the data block by
  99.                         block. Every block will only be written in compressed
  100.                         format if the compression actually saved space.
  101.                         This is done to avoid overhead for already compressed
  102.                         files (eg ZIP archives). During the process of
  103.                         restore UBACKUP decompresses every compressed block
  104.                         automatically. The value of this property is only
  105.                         relevant during backup.
  106.  
  107. BackupOn  : String;    This property specifies the destination of the backup
  108.                         respectively the source for the restore of files.
  109.                         You can specify a drive letter and optional a path
  110.                         where the backup files should go. To have your files
  111.                         backed up to the first disk drive set this
  112.                         property to A:\
  113.  
  114. FileList    : String;    You can (since Version 1.01) use two ways of setting
  115.                         which files to backup. If you set the
  116.             UseExternalFileList property to true, you can use
  117.                         this property :
  118.                         Put all the filenames of the files you want to be
  119.                         backed up in to a textfile which name you specify
  120.                         with this property. Every filename goes in one line
  121.                         of the filelist. You should include Drive and
  122.                         complete path with each file. This property and the
  123.                         way UBACKUP handles the files to backup will be
  124.                         improved with the next version. This property is
  125.                         only relevant during backup operations. During
  126.                         restore all files are currently restored to where
  127.                         they came frome.
  128.  
  129. Overwrite   : Boolean;     This property determines, if existing files during
  130.                         backup or restore are overwritten without
  131.                         confirmation. If you set this property to true,
  132.                         eventually existing files on your backup destination
  133.                         will be deleted without reconfirmation ! To avoid
  134.                         any "accidents" the backup destination "C:\"
  135.                         wont be accepted together with the Overwrite
  136.                         property set to true. During restore this property
  137.                         determines if existing version of the files to
  138.                         be restored will be replaced. If you set this
  139.                         option to false you will generally be asked if you
  140.                         really want to delete files.
  141.  
  142. Description : String;     This property give space to name your backup set.
  143.                         During backup is the value of this property
  144.                         written as descriptional header to your backupr.
  145.                         During restore this property is undefined.
  146.  
  147. FileAtWork  : String;    This property is only valid during the backup /
  148.                         restore process. It∩s value shows the name of the
  149.                         file actually processed. If you react on the
  150.                         OnNextFile event described later than you are
  151.                         able to inform the user of the things going on.
  152.  
  153. Language  : TLanguages;    This property allows to choose between different
  154.                         languages for the text being used in the message
  155.                         boxes presented to the user. If you set some of
  156.                         the notification events described later on, you
  157.                         can do the presentation of warnings etc. To the
  158.                         user yourself inside your application. As far you
  159.                         can choose between German and English language
  160.                         here. More language on request to come.
  161.  
  162. Percent      : Integer;    This value is only defined during backup / restore
  163.                         processes and shows the percentage of work done.
  164.  
  165. Answer  : (Yes,No,All)    This value indicates the preferred action of the
  166.                         user for overwriting an existing file. This
  167.